home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 98 / Skunkware 98.iso / src / interp / tclStruct1.2.tar.gz / tclStruct1.2.tar / tclStruct1.2 / README < prev    next >
Text File  |  1995-10-17  |  3KB  |  90 lines
  1. TclStruct
  2.  
  3.   by Matthew Costello
  4.   matthew.costello@sandiegoca.attgis.com
  5.  
  6.   based on Laurent Demailly's tclbin package
  7.       http://hplyot.obspm.fr/~dl/tclbin.html
  8.  
  9. @(#)tclStruct:README    1.5    95/10/17
  10.  
  11. 1. Introduction
  12. ---------------
  13.  
  14. This directory contains the sources and documentation for tclStruct,
  15. a loadable extension to Tcl.  The tclStruct extension supports the
  16. definition of 'C' data structures and the mapping of these (binary)
  17. data structures into Tcl through the use of associative arrays.
  18.  
  19. It is being used here to test the binary API (Application Programming
  20. Interface) of a software package.
  21.  
  22. 2. Documentation
  23. ----------------
  24.  
  25. The "doc" subdirectory in this release contains a complete set of
  26. reference manual entries for the Tcl commands provided by tclStruct.
  27. Files with extension ".3" are for C library procedures and files
  28. with extension ".n" describe Tcl commands.  There are no section 3
  29. manual pages yet.
  30. To print any of the man pages, cd to the "doc" directory and invoke
  31. your favorite variant of troff using the normal -man macros, e.g.
  32.     ditroff -man typedef.n
  33.  
  34. In addition, the "ex" subdirectorie contains some example Tcl code.
  35.  
  36. The 'real' documentation is the source in this directory.
  37.  
  38. 3. Compilation on Unix
  39. ----------------------
  40.  
  41. This release should compile and run with trivial changes on
  42. any UNIX-like system.
  43.  
  44.   (a)    Unpack this distribution (you already have) and apply any
  45.     patches.
  46.   (b)    Run the ./configure script to create the Makefile.
  47.   (c)    Edit the "Makefile" if necessary to add any necessary compiler
  48.     flags.
  49.   (c)   Type "make".  This will create a library archive called
  50.     "libtclStruct.a" and an interpreter application called
  51.     "tclStruct".
  52.     If dynamic loading is available then "make" will create a
  53.     shared library instead.
  54.   (d)    If the make fails you will need to edit the Makefile and try again.
  55.   (e)    Type "make install" to install everything.
  56.  
  57. 4. Test suite
  58. -------------
  59.  
  60. There is a test suite in the subdirectory "tests".
  61. To use it just type "make test".
  62.  
  63. To run the test suite if your tclsh has the 'load' command,
  64. type "make test-dl".
  65.  
  66. 5. Support and bug fixes
  67. ------------------------
  68.  
  69. I'm interested in receiving bug reports and suggestions for improvements
  70. in tclStruct.  I do read comp.lang.tcl, but if you want to make sure I
  71. see something also send it to me via email.
  72.  
  73. 6. Dynamic loading
  74. ------------------
  75.  
  76. This library may also be dynamically loaded into any version of Tcl
  77. that supports dynamic loading.  Tcl 7.5 (not yet released) will
  78. support dynamic loading using the 'load' command.
  79.  
  80. When dynamic loading is available the configure script will try to
  81. automatically configure dynamic loading.  In this case the generated
  82. Makefile will build a dynamically loadable library rather than
  83. an old-fashioned archive.
  84.  
  85. 7. Compiling on non-UNIX systems
  86. --------------------------------
  87.  
  88. The tclStruct extension uses only only standard 'C' and should be portable
  89. to any machine on which Tcl will run.
  90.